IRIX Base Documentation 2002 November/SGI IRIX Base Documentation 2002 November.iso/usr/share/catman/p_man/cat3/il/ilKernel.z/ilKernel

Text File | 2002-10-03 | 14.2 KB | 397 lines

iiiillllKKKKeeeerrrrnnnneeeellll((((3333))))        IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll        iiiillllKKKKeeeerrrrnnnneeeellll((((3333))))



NNNNAAAAMMMMEEEE
     iiiillllKKKKeeeerrrrnnnneeeellll - class to define a kernel

IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
     ilWatchedObject

HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
     #include <il/ilKernel.h>

CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     ilKernel is the base class for deriving a three-dimensional kernel.  An
     ilKernel is defined by an _x, _y, and _z dimension, a data type, the kernel
     data, and the kernel origin. ilKernel also provides functions to access
     kernel attributes and data.

     An ilKernel is conceptually equivalent to a three-dimensional  matrix
     whose elements are stored in row major form. Additionally, a kernel can
     have an origin, typically at the center of the matrix.

     ilKernel, by default, defines a general kernel. iiiillllSSSSeeeeppppKKKKeeeerrrrnnnneeeellll is a
     separable kernel derived from ilKernel.


CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
     CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrrssss

          ilKernel(iflDataType type, void *d=NULL, int x=1, int y=1,
                   int z=1)
          ilKernel()     _p_r_o_t_e_c_t_e_d


     FFFFuuuunnnnccccttttiiiioooonnnnssss ttttoooo sssseeeetttt////ggggeeeetttt kkkkeeeerrrrnnnneeeellll aaaattttttttrrrriiiibbbbuuuutttteeeessss

          int getXsize()
          int getYsize()
          int getZsize()
          void getSize(int& x, int& y, int& z)
          void getOrigin(int &x, int &y, int &z)
          void setOrigin(int x, int y, int z)
          iflDataType getDataType()
          ilKernelType getKernelType()
          virtual int isEquivalent(const ilKernel *otherKernel)
          void setClamp(int on=TRUE)
          int isClampSet()


     GGGGeeeettttttttiiiinnnngggg aaaannnndddd sssseeeettttttttiiiinnnngggg kkkkeeeerrrrnnnneeeellll ddddaaaattttaaaa

          virtual double getElement(int x, int y=0, int z=0)
          virtual void setElement(double val, int x, int y=0, int z=0)
          void *getData()
          void setData(const void *data)



                                                                        PPPPaaaaggggeeee 1111






iiiillllKKKKeeeerrrrnnnneeeellll((((3333))))        IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll        iiiillllKKKKeeeerrrrnnnneeeellll((((3333))))



          virtual void scale(double s)
          virtual ilKernel* copy()


     UUUUttttiiiilllliiiittttyyyy ffffuuuunnnnccccttttiiiioooonnnnssss

          virtual void operator=(const ilKernel &kernel)
          void init(iflDataType type, void* d=NULL, int x=1, int y=1,
                    int z=1)  _p_r_o_t_e_c_t_e_d
          double getVal(int i)     _p_r_o_t_e_c_t_e_d
          void setVal(double val, int i)     _p_r_o_t_e_c_t_e_d
          int offset(int x)   _p_r_o_t_e_c_t_e_d
          int offset(int x, int y, int z)    _p_r_o_t_e_c_t_e_d
          virtual void calcGain(double& min, double& max)
          void calcPassGain(int off, int len, double& min, double& max)    _p_r_o_t_e_c_t_e_d


FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
     iiiillllKKKKeeeerrrrnnnneeeellll(((())))

          ilKernel(iflDataType type, void *d=NULL, int x=1, int y=1,
                   int z=1)
          ilKernel()     _p_r_o_t_e_c_t_e_d


          Construct a kernel by copying user data, assumed to be in row major
          order.  If the pointer _d_a_t_a is NULL, memory is still allocated in
          the specified size, but no data is copied.  By default, the kernel
          origin is set to (x/2, y/2, z/2), and the kernel type is
          _i_l_K_e_r_n_G_e_n_e_r_a_l.

          The second form of the constructor is used for derived classes, it
          creates an unitialized object.

     ccccaaaallllccccGGGGaaaaiiiinnnn(((())))

          virtual void calcGain(double& min, double& max)


          This method calculates the worst case gain applied to an input
          range, the passed in _m_i_n and _m_a_x values are updated with the result
          of applying the worst case gain.

     ccccaaaallllccccPPPPaaaassssssssGGGGaaaaiiiinnnn(((())))

          void calcPassGain(int off, int len, double& min, double& max)    _p_r_o_t_e_c_t_e_d


          Used to compute the worst case gain for a segment of the kernel data
          vector indicated by _o_f_f and _l_e_n.  The passed in _m_i_n and _m_a_x values
          are updated with the result of applying the worst case gain.




                                                                        PPPPaaaaggggeeee 2222






iiiillllKKKKeeeerrrrnnnneeeellll((((3333))))        IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll        iiiillllKKKKeeeerrrrnnnneeeellll((((3333))))



     ccccooooppppyyyy(((())))

          virtual ilKernel* copy()


          Constructs a kernel which is a copy of this kernel.  The kernel data
          is copied into the returned object.

     ggggeeeettttDDDDaaaattttaaaa(((())))

          void *getData()


          Returns a pointer to the kernel data.  Use the kernel data type to
          cast pointer to the correct type.

     ggggeeeettttDDDDaaaattttaaaaTTTTyyyyppppeeee(((())))

          iflDataType getDataType()


          Returns the type of the kernel data.

     ggggeeeettttEEEElllleeeemmmmeeeennnntttt(((())))

          virtual double getElement(int x, int y=0, int z=0)


          Returns one element from the kernel data, indexed by _x, _y, _a_n_d _z.

     ggggeeeettttKKKKeeeerrrrnnnneeeellllTTTTyyyyppppeeee(((())))

          ilKernelType getKernelType()


          Returns the kernel type, _i_l_K_e_r_n_G_e_n_e_r_a_l for a general kernel, and
          _i_l_K_e_r_n_S_e_p_a_r_a_b_l_e for a separable kernel.

     ggggeeeettttOOOOrrrriiiiggggiiiinnnn(((())))

          void getOrigin(int &x, int &y, int &z)


          Returns the kernel's origin in _x, _y, _z.

     ggggeeeettttSSSSiiiizzzzeeee(((())))

          void getSize(int& x, int& y, int& z)







                                                                        PPPPaaaaggggeeee 3333






iiiillllKKKKeeeerrrrnnnneeeellll((((3333))))        IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll        iiiillllKKKKeeeerrrrnnnneeeellll((((3333))))



          Returns the kernel's (x,y,z) size in _x, _y, and _z respectively.

     ggggeeeettttVVVVaaaallll(((())))

          double getVal(int i)     _p_r_o_t_e_c_t_e_d


          Treating the data pointed to by _d_a_t_a as a single dimensional array,
          the method returns the _ith element as a double.

     ggggeeeettttXXXXssssiiiizzzzeeee(((())))

          int getXsize()


          Returns the _x dimension of the kernel.

     ggggeeeettttYYYYssssiiiizzzzeeee(((())))

          int getYsize()


          Returns the _y dimension of the kernel.

     ggggeeeettttZZZZssssiiiizzzzeeee(((())))

          int getZsize()


          Returns the _z dimension of the kernel.

     iiiinnnniiiitttt(((())))

          void init(iflDataType type, void* d=NULL, int x=1, int y=1,
                    int z=1)  _p_r_o_t_e_c_t_e_d


          This method reinitializes the kernel to have the specified
          attributes.  The data type will be set to _t_y_p_e, the size to _x, _y,
          and _z, and the data will be copied from _d, or initialized to all
          ones, if _d is NULL.

     iiiissssCCCCllllaaaammmmppppSSSSeeeetttt(((())))

          int isClampSet()


          This method returns TRUE if this kernel is intended for use with
          clamping.






                                                                        PPPPaaaaggggeeee 4444






iiiillllKKKKeeeerrrrnnnneeeellll((((3333))))        IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll        iiiillllKKKKeeeerrrrnnnneeeellll((((3333))))



     iiiissssEEEEqqqquuuuiiiivvvvaaaalllleeeennnntttt(((())))

          virtual int isEquivalent(const ilKernel *otherKernel)


          Returns TRUE if _o_t_h_e_r_K_e_r_n_e_l has the same dimensions, data type, and
          data of this kernel, and returns FALSE otherwise.

     ooooffffffffsssseeeetttt(((())))

          int offset(int x, int y, int z)    _p_r_o_t_e_c_t_e_d
          int offset(_i_n_t _x)   _p_r_o_t_e_c_t_e_d


          Returns the number of bytes offset from the beginning of the kernel
          data to the element at location (x, y, z).  The second form treats
          the kernel data as a one dimensional vector.

     ooooppppeeeerrrraaaattttoooorrrr====(((())))

          virtual void operator=(const ilKernel &kernel)


          Copies the contents of _k_e_r_n_e_l into this kernel, reallocating data if
          the size of new kernel data differs from the current size.

     ssssccccaaaalllleeee(((())))

          virtual void scale(double s)


          This method scales all the kernel weights by _s.

     sssseeeettttCCCCllllaaaammmmpppp(((())))

          void setClamp(int on=TRUE)


          This method is used to indicate that the kernel is intended to be
          used with clamping, the values returned by ccccaaaallllccccGGGGaaaaiiiinnnn() will then be
          simply adjusted for the kernel gain, not for the worst case
          behavior.

     sssseeeettttDDDDaaaattttaaaa(((())))

          void setData(const void *data)


          Copies _d_a_t_a into the kernel. The data is assumed to be of the type
          and dimensions corresponding to the size and type used in the kernel
          construction.




                                                                        PPPPaaaaggggeeee 5555






iiiillllKKKKeeeerrrrnnnneeeellll((((3333))))        IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll        iiiillllKKKKeeeerrrrnnnneeeellll((((3333))))



     sssseeeettttEEEElllleeeemmmmeeeennnntttt(((())))

          virtual void setElement(double val, int x, int y=0, int z=0)


          Sets one element from the kernel data, indexed by _x, _y, _a_n_d _z. _t_o
          _v_a_l.

     sssseeeettttOOOOrrrriiiiggggiiiinnnn(((())))

          void setOrigin(int x, int y, int z)


          Set the kernel origin to (x, y, z);

     sssseeeettttVVVVaaaallll(((())))

          void setVal(double val, int i)     _p_r_o_t_e_c_t_e_d


          Treating the data pointed to by _d_a_t_a as a single dimensional array,
          the method sets the _ith element to _v_a_l.

IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
   IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllWWWWaaaattttcccchhhheeeeddddOOOObbbbjjjjeeeecccctttt
     addWatchCallback(), doWatchCallbacks(), removeWatchCallback()

SSSSEEEEEEEE AAAALLLLSSSSOOOO
     ilSepKernel


























                                                                        PPPPaaaaggggeeee 6666